Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: replaced some dummy APIs #36655

Closed
wants to merge 2 commits into from

Conversation

NandanAnantharamu
Copy link
Collaborator

@NandanAnantharamu NandanAnantharamu commented Oct 2, 2024

/ok-to-test tags="@tag.All"
EE PR: https://github.com/appsmithorg/appsmith-ee/pull/5272

Caution

🔴 🔴 🔴 Some tests have failed.
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/11162865103
Commit: 205958c
Cypress dashboard.
Tags: @tag.All
Spec:
The following are new failures, please fix them before merging the PR:

  1. cypress/e2e/Regression/ClientSide/ExplorerTests/Widgets_Sidebar.ts
List of identified flaky tests.
Thu, 03 Oct 2024 16:50:28 UTC

Summary by CodeRabbit

  • New Features

    • Updated API endpoint for authentication in Production and Staging environments.
    • Added new configuration property for Okta username.
  • Bug Fixes

    • Improved database connection parameters for enhanced reliability.

Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

Walkthrough

The changes in the pull request involve modifications to the DataManager class located in app/client/cypress/support/Objects/DataManager.ts. The updates include changing the authenticatedApiUrl for the Production and Staging environments from "https://fakeapi.com" to "http://host.docker.internal:5001". Additionally, a new property, okta_username, has been introduced with the value "[email protected]". These adjustments are aimed at refining the configuration settings for database connections and API interactions across different environments.

Changes

File Path Change Summary
app/client/cypress/support/Objects/DataManager.ts Updated authenticatedApiUrl from "https://fakeapi.com" to "http://host.docker.internal:5001" and added okta_username: "[email protected]"

Possibly related PRs

  • test: replace 3rd party API1 CE #36518: This PR modifies the API URL in the API_Edit_spec.js file to use http://host.docker.internal:5001, which aligns with the changes made to the authenticatedApiUrl in the DataManager class.
  • test: replace 3rd party api with TED #36594: This PR updates the API endpoint in the JsOnLoad3_Spec.ts file to http://host.docker.internal:5001, similar to the changes in the main PR regarding the API URL configuration.
  • test: replaced 3rd party apit in treeSelect #36598: This PR changes the API endpoint in the Tree_Select_2_spec.ts file to a local Docker host URL, reflecting the same pattern of updating URLs to http://host.docker.internal as seen in the main PR.

Suggested reviewers

  • ApekshaBhosale
  • sagar-qa007

Poem

In the realm of code where changes flow,
The DataManager shines with a new glow.
URLs updated, a username bright,
Configs align, making everything right.
With every tweak, we learn and grow,
In the world of APIs, let creativity show! 🌟


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 84c6538 and 205958c.

📒 Files selected for processing (1)
  • app/client/cypress/support/Objects/DataManager.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • app/client/cypress/support/Objects/DataManager.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test labels Oct 2, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 688324e and 84c6538.

📒 Files selected for processing (1)
  • app/client/cypress/support/Objects/DataManager.ts (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/client/cypress/support/Objects/DataManager.ts (1)

Pattern app/client/cypress/**/**.*: Review the following e2e test code written using the Cypress test library. Ensure that:

  • Follow best practices for Cypress code and e2e automation.
  • Avoid using cy.wait in code.
  • Avoid using cy.pause in code.
  • Avoid using agHelper.sleep().
  • Use locator variables for locators and do not use plain strings.
  • Use data-* attributes for selectors.
  • Avoid Xpaths, Attributes and CSS path.
  • Avoid selectors like .btn.submit or button[type=submit].
  • Perform logins via API with LoginFromAPI.
  • Perform logout via API with LogOutviaAPI.
  • Perform signup via API with SignupFromAPI.
  • Avoid using it.only.
  • Avoid using after and aftereach in test cases.
  • Use multiple assertions for expect statements.
  • Avoid using strings for assertions.
  • Do not use duplicate filenames even with different paths.
  • Avoid using agHelper.Sleep, this.Sleep in any file in code.
🔇 Additional comments (1)
app/client/cypress/support/Objects/DataManager.ts (1)

108-108: ⚠️ Potential issue

Class, let's discuss the change in our authenticatedApiUrl.

I see you've updated our API URL, but I have a few points for us to consider:

  1. We've switched from "https" to "http". Can anyone tell me why this might be a concern?
  2. The new URL uses "host.docker.internal". Who can explain what this means for our development environment?
  3. We've added a specific port number. Why might this be important?

Let's think about these questions and discuss how they might affect our application's security and deployment process.

To verify the impact of this change, let's run a quick check:

Can someone volunteer to run this script and share the results with the class?

Also applies to: 205-205


GraphqlApiUrl_TED: "http://host.docker.internal:4200/graphql",

twilio_username: "random-username",
twilio_password: "random-password",

okta_username: "[email protected]",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Let's examine the new okta_username property, class.

I notice we've added a new property for Okta authentication. This is an interesting addition to our configuration. However, I have a few questions for you to ponder:

  1. Why might using the same email for both Production and Staging environments be problematic?
  2. Can anyone explain the potential risks of hardcoding credentials in our code?
  3. How could we improve this implementation to align with best security practices?

Remember, in the real world, we always want to protect our application and user data. Let's brainstorm some better approaches to handling authentication credentials.

Would you like me to propose a more secure way to manage these credentials? We could explore environment variables or a secure credential management system.

Also applies to: 212-212

@NandanAnantharamu NandanAnantharamu added the ok-to-test Required label for CI label Oct 3, 2024
removed unwanted data
@NandanAnantharamu NandanAnantharamu added ok-to-test Required label for CI and removed ok-to-test Required label for CI labels Oct 3, 2024
@NandanAnantharamu
Copy link
Collaborator Author

closing this as its redundant

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok-to-test Required label for CI skip-changelog Adding this label to a PR prevents it from being listed in the changelog Test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant